Socket
Socket
Sign inDemoInstall

@beisen-phoenix/button

Package Overview
Dependencies
Maintainers
1
Versions
435
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@beisen-phoenix/button

> @beisen-phoenix/button


Version published
Weekly downloads
70
increased by1066.67%
Maintainers
1
Weekly downloads
 
Created
Source

按钮

@beisen-phoenix/button

概述

按钮控件的作用是引发即时操作,即当用户单击后,触发即时操作,作为基础控件之一,按钮广泛应用于不同平台的产品中。

完整的按钮视觉体系包含强、中、弱3个层次。按钮的状态分为Normal、Hover、Click3种常会状态和Disabled、Loading中非常规状态。

由以下几个子组件构成

Button 比较常见的button

IconButton 点击icon触发事件

TextButton 文字按钮,点击触发事件

ButtonGroup 普通的按钮组,类似单选效果

IconButtonGroup iconButton的组合

Button API

参数说明类型默认值是否必传
size按钮的大小可选值包括 super、big、middle、smallmiddle
type按钮的类型可选值包括 primary、secondary、normalprimary
disabled是否禁用booleanfalse
loading是否处于loading状态(loading图标为内置图标,不可替换)booleanfalse
preIcon前置iconJSX.Element--
suffixIcon后置iconJSX.Element--
ref用来获取button的dom实例的引用(dom) =>--
onClick点击按钮的回调函数function(e) => void
extraCls扩展的class名称,一般用于样式扩展string--

IconButton API

参数说明类型默认值是否必传
type按钮类型primary(主)、secondary(次)、normal(弱,仅用于有边框时)primary
disable是否禁用booleanfalse
tipInfo按钮hover时显示的提示信息string--
children子组件,是一个Icon的组件React.ReactNode--
loading是否处于loading状态(loading图标为内置图标,不可替换)booleanfalse
hasBorder是否显示边框booleanfalse
ref用来获取button的dom实例的引用(dom) =>--
onClick点击按钮的回调函数function(e) => void
extraCls扩展的class名称,一般用于样式扩展string--

TextButton API

参数说明类型默认值是否必传
type按钮类型primary、secondaryprimary
size按钮的大小可选值包括 big、smallbig
disable是否禁用booleanfalse
loading是否处于loading状态(loading图标为内置图标,不可替换)booleanfalse
text按钮的显示文字string--
preIcon前置iconJSX.Element--
suffixIcon后置iconJSX.Element--
onClick点击按钮的回调函数function(e) => void
extraCls扩展的class名称,一般用于样式扩展string--

ButtonGroup API

参数说明类型默认值是否必传
type按钮类型primary、secondaryprimary
size按钮的大小可选值包括 big、smallbig
initialIndex默认激活第几个number
items按钮组的数据object {disable?: boolean, text: string}[]
onClick点击按钮的回调函数function(item,e,index) => void
activeIndex指定当前激活第几个number
extraCls扩展的class名称,一般用于样式扩展string--

IconButtonGroup API

参数说明类型默认值是否必传
icons按钮组的自定义icon[{ icon?: JSX.Element, tipInfo?: string, direct?: string, disable?: boolean }][]
onClick点击按钮的回调函数function(index,item,e) => void
extraCls扩展的class名称,一般用于样式扩展string--
initialIndex默认激活第几个number
activeIndex指定当前激活第几个number

FAQs

Package last updated on 25 Nov 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc